Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix #537 - Add surge.sh preview GHA #539

Merged
merged 9 commits into from
Mar 6, 2024
Merged

Fix #537 - Add surge.sh preview GHA #539

merged 9 commits into from
Mar 6, 2024

Conversation

ricardozanini
Copy link
Member

@ricardozanini ricardozanini commented Feb 16, 2024 •
edited
Loading

Fixes #537

Description:
PR to get back with our some claimed guides preview! Please note that the CI will also fail if you don't fix the references and other buggy code in the adoc pages.

Depending on:

Please make sure that your PR meets the following requirements:

  • You have read the contributions doc
  • Pull Request title is properly formatted: Issue-XYZ Subject
  • Pull Request title contains the target branch if not targeting main: [0.9.x] Issue-XYZ Subject
  • The nav.adoc file has a link to this guide in the proper category
  • The index.adoc file has a card to this guide in the proper category, with a meaningful description
How to backport a pull request to a different branch?

In order to automatically create a backporting pull request please add one or more labels having the following format backport-<branch-name>, where <branch-name> is the name of the branch where the pull request must be backported to (e.g., backport-7.67.x to backport the original PR to the 7.67.x branch).

NOTE: backporting is an action aiming to move a change (usually a commit) from a branch (usually the main one) to another one, which is generally referring to a still maintained release branch. Keeping it simple: it is about to move a specific change or a set of them from one branch to another.

Once the original pull request is successfully merged, the automated action will create one backporting pull request per each label (with the previous format) that has been added.

If something goes wrong, the author will be notified and at this point a manual backporting is needed.

NOTE: this automated backporting is triggered whenever a pull request on main branch is labeled or closed, but both conditions must be satisfied to get the new PR created.

@ricardozanini ricardozanini removed the request for review from MarianMacik February 16, 2024 20:56
ricardozanini
ricardozanini commented Feb 16, 2024
View reviewed changes
.github/workflows/sw-docs-pr.yml
- run: export DOCSEARCH_ENABLED=true
- run: export DOCSEARCH_ENGINE=lunr
- run: export NODE_PATH="$(npm -g root)"
- run: npm -v
- run: npm run install-build
- run: npm run local-install-build
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This way we force the action to FAIL in case of any problems within the PR. In this action, doesn't make much sense to run the full build. That's only required when publishing on the live website.

@domhanak
Copy link
Contributor

LGTM, looks like https://issues.apache.org/jira/browse/INFRA-25513 is still waiting.
I understand the infra tickets need to resolved for this to work, but I am not sure if I am able to test this

@ricardozanini
Copy link
Member Author

@domhanak as soon as those tickets are solved, I'll rerun the actions and you can verify the preview website.

@domhanak domhanak mentioned this pull request Feb 26, 2024
Merged
7 tasks
@domhanak
Copy link
Contributor

domhanak commented Feb 26, 2024 •
edited
Loading

@ricardozanini I figured the issues on my PR:
custom-functions-support.adoc

Contains {category} and {multiplier} in plain text ( not those [source,bash] etc ones)
Fix is to add \{category} and \{multiplier} so they are not resolved

@ricardozanini
Copy link
Member Author

@ricardozanini I figured the issues on my PR: custom-functions-support.adoc

Contains {category} and {multiplier} in plain text ( not those [source,bash] etc ones) Fix is to add \{category} and \{multiplier} so they are not resolved

They are not resolved? @domhanak 🤔

@domhanak
Copy link
Contributor

domhanak commented Feb 26, 2024 •
edited
Loading

@ricardozanini in that example it seems intentional for these to be used this, way. I did not find any definition prior to their use

@ricardozanini
Copy link
Member Author

oh I misread. Not resolved is the {}. 😅

@ricardozanini ricardozanini mentioned this pull request Mar 6, 2024
Merged
@ricardozanini
Copy link
Member Author

@domhanak I'm merging this since I need to verify if the preview workflow runs. And it will only run if the workflow is in the default/main branch: https://github.com/orgs/community/discussions/25288

@ricardozanini ricardozanini merged commit 9060377 into apache:main Mar 6, 2024
3 checks passed
@ricardozanini ricardozanini deleted the issue-537 branch March 6, 2024 17:12
@ricardozanini ricardozanini mentioned this pull request Mar 6, 2024
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@domhanak domhanak domhanak approved these changes

@krisv krisv Awaiting requested review from krisv krisv is a code owner

@jakubschwan jakubschwan Awaiting requested review from jakubschwan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documetation previews from pull requests
2 participants
@ricardozanini @domhanak